Improve help and doc #22 - #23
Merged
Merged
Conversation
* Add overview section in README and in doc * Use rst for README * Remove copyright years from notices * Use venv subdirectory for virtualenv Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne
commented
Sep 10, 2022
| @@ -0,0 +1,126 @@ | |||
| ScanCode LicenseDB | |||
Member
Author
There was a problem hiding this comment.
@mjherzog @DennisClark FYI... this parts would need your review and I could then propagate the edits to the help page too
pombredanne
requested review from
AyanSinhaMahapatra,
DennisClark and
mjherzog
September 10, 2022 20:21
* add new CLA license category * update license category docs * update reference to .LICENSE files correctly Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
AyanSinhaMahapatra
force-pushed
the
improve-help-and-doc
branch
from
January 9, 2023 09:36
daa1e25 to
b4ebc6b
Compare
AyanSinhaMahapatra
approved these changes
Jan 9, 2023
AyanSinhaMahapatra
left a comment
Member
There was a problem hiding this comment.
I've pushed a commit with some minor changes:
- update reference to .LICENSE files correctly
- update README with the same and misc
- add new CLA license category
- update license category docs
DennisClark
approved these changes
Jan 9, 2023
DennisClark
left a comment
Member
There was a problem hiding this comment.
approved for Earth and beyond!
Member
Author
|
@AyanSinhaMahapatra ^ not sure how this meshes with your work in progress in ScanCode toolkit |
Member
|
@pombredanne I've had pushed a commit here and also updated this in #26 so it is all updated AFAIK |
AyanSinhaMahapatra
added a commit
to aboutcode-org/scancode-toolkit
that referenced
this pull request
Jan 17, 2023
Reference: aboutcode-org/scancode-licensedb#23 Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
4 tasks
Member
|
No we missed the help.html which got replaced as we now build from scancode-toolkit. Opened a PR to fix this. |
pombredanne
added a commit
to aboutcode-org/scancode-toolkit
that referenced
this pull request
Jan 18, 2023
Restore help.html from aboutcode-org/scancode-licensedb#23
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR improves the intro documentation in the readme and the generated website help page.
Reference: #22